home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_1
/
cmagi134.zip
/
CMSYS.DOC
< prev
next >
Wrap
Text File
|
1991-11-09
|
32KB
|
1,107 lines
<<<<< SYSOP UTILITIES NOT INCLUDED WITH UNREGISTERED PACKAGE >>>>>
██▒▒██▒▒██▒▒██▒▒██▒▒
▒▒██▒▒██▒▒██▒▒██▒▒██ ChessMAGIC! Utilities
██▒▒██▒▒██▒▒██▒▒██▒▒ (c)1991
▒▒██▒▒██▒▒██▒▒██▒▒██ Knightware/Bud Bradley
██▒▒██▒▒██▒▒██▒▒██▒▒
▒▒██▒▒██▒▒██▒▒██▒▒██ in association with
██▒▒██▒▒██▒▒██▒▒██▒▒ Decibel BBS
▒▒██▒▒██▒▒██▒▒██▒▒██
SYSOP'S REFERENCE MANUAL
Distributed by
KnightWare
465 Ridgedale Way
Lawrenceville, GA 30244
(404) 978-2893
Decibel BBS
Atlanta, GA
Tom Brady, Sysop
(404) 288-6858 1200/2400/9600 (HST)
(404) 284-1152 1200/2400 (MNP/V42)
Copyright (c)1991 Bud Bradley/KnightWare
All Rights Reserved
I N T R O D U C T I O N
NOTE: If you have difficulty with any aspect of utility operations, please
contact us!
========================
This utility program provides you, the registered ChessMAGIC! Sysop, with
various maintenance controls, including (but not necessarily limited to):
Defining/Editing Game Play Areas
Adding/Deleting/Editing Players
Deleting/Editing Games
Automated Tournament/Team Pairings
- Page i -
A C K N O W L E D G M E N T S
KnightWare wishes to express our sincere thanks to Decibel BBS and a few of
its members (Larry Phillips, Al Schrank, Jay Eidex, Warren De Mers and
especially Tom Brady), for their suggestions, patience and encouragement.
- Page ii -
T a b l e o f C o n t e n t s
Section Title Page
1.0 INSTALLATION 1
1.1 Associated Files and Descriptions 1
2.0 MAIN MENU OPTIONS 1
2.1 AREAS 2
2.1.1 Add New Chess Area 2
2.1.2 Edit Existing Chess Area 6
2.1.3 Game Maintenance 6
2.1.4 BBS Chess Conversion 9
2.2 PLAYERS 10
2.2.1 Add New Player 10
2.2.2 Edit Existing Player 12
2.3 SPECIAL 12
2.3.1 Create Pairings 13
2.4 UTILITY 13
2.5 QUIT 13
3.0 PRODUCT SUPPORT 14
4.0 DISCLAIMER/AGREEMENT 14
- Page iii -
------------------------------------------------------------------------------
1.0 INSTALLATION
------------------------------------------------------------------------------
Place CMSYS.EXE and CMSYSV.HLP in your CMAGIC directory (or whatever
directory you have previously installed the ChessMAGIC! system).
That's all there is to the installation!
------------------------------------------------------------------------------
1.1 Associated Files and Descriptions
------------------------------------------------------------------------------
CMSYS.EXE - executable program
CMSYSV.HLP - associated help file
NOTE: DO NOT ALTER OR REMOVE THESE FILES! If you do, erratic
ChessMAGIC! operation and/or system lockup may occur!
------------------------------------------------------------------------------
2.0 MAIN MENU OPTIONS
------------------------------------------------------------------------------
The main menu consists of several options (detailed in Sections 3
through 7):
Areas Players Special Utility Quit
The first letter of each option is highlighted, so press the
corresponding keyboard character to make your choice. Each option will
present you with a sub-menu of associated actions to be performed.
Again, the highlighted letter is your keyboard character to press, or
you may use your arrow and <ENTER> combination for selection:
Left/Right Arrows = Scroll left/right through option sub-menus
UP/Down Arrows = Scroll up/down through action selections
Press <ESC> to back out of any utilities area.
To perform edits to the various fields within each option, use your
<TAB> key to move from field to field. The <ENTER> key is used to move
quickly, from line to line (first field on each line).
- Page 1 -
------------------------------------------------------------------------------
2.1 AREAS
------------------------------------------------------------------------------
This menu provides you with the means for defining/editing game areas
(single or multiple), games data and converting pre-existing "other"
BBS chess-type program's (i.e. BBS-Chess) game files to ChessMAGIC!
format. The menu consists of these command actions:
A) Add New Chess Area
B) Edit Existing Area
C) Game Maintenance
D) BBS Chess Conversion
------------------------------------------------------------------------------
2.1.1 Add New Chess Area
------------------------------------------------------------------------------
With careful planning, you can provide your users with several chess
playing areas to choose from. These can include rated, unrated, teams,
tournaments, etc. Only your imagination is your limit! Keep in mind,
ChessMAGIC! is limited to tracking no more than 9,999,999 games per
area... If this becomes a problem, let our grandchildren know!
Pressing "A" will result in an area definition screen, ready to have
these blank fields defined by you:
Door ID -
Each game area (i.e. "door") MUST have its own unique ID. This
tag is used as the file name for that gaming area's database and
index files, so do NOT use the same ID twice! Only alphanumeric
characters may be used -- no periods, dashes, etc. Examples:
rated
unrated
tourney1
These ID's are not displayed to your users, so use whatever you
can keep track of best.
- Page 2 -
Description -
This entry will be displayed in your ChessMAGIC! main menu, so
your users can see at a glance in just what game area they are
currently involved.
Also, it will be displayed when using the "S" command to change
playing areas and upon first entering ChessMAGIC! from your BBS.
Normally, your description would correspond to the type of games
your users could expect to encounter in each area:
* RATED *
* UNRATED *
* TEAM TOURNAMENT *
Door Path -
Define each game area path here; do NOT specify file names or
use ending slashes. If your game areas branch off the default
ChessMAGIC! system directory, there's no need to specify
anything but that branch directory (as shown in the first
example):
rated
d:\doors\cmagic\rated
f:\rated
Maximum Games -
Enter the maximum number of games you wish ChessMAGIC! to
track/store in this game area. Game entry files are created
only as games are started and completed games are NOT deleted.
The game area master file is not pre-allocated, either. You may
increase this figure, later, if you feel it was set too low.
Once this defined limit is reached, ChessMAGIC! will not allow
new games to be opened. You then must purge old games (i.e.
archive them, delete them, etc.).
ChessMAGIC! will track a maximum of 9,999,999 games in EACH
area. Let your system disk storage be your guide!
Maximum Games Active per Player -
Set this to limit the number of games a player may open/join.
Once this limit is reached, a player must complete a game before
another may be opened/joined.
- Page 3 -
Defaults: Number of Moves -
An optional setting, this is similar to the default system used
in postal chess and is used in conjunction with "Number of Days"
definition. This will determine the number of moves a player
MUST make in x number of days, before a game default occurs.
Leaving this field blank or entering a 0 is equivalent to 1.
Defaults: Number Days -
An optional setting, this defines the number of days (beginning
from last move date) may lapse before a default occurs.
Rating Style -
R = Rated
C = Unrated (casual)
T = Tournament
When R or T is entered, a player's ratings will be updated upon
game completion.
When T is entered, ChessMAGIC! will prevent new games from being
opened. Use the pairing feature (see Section 5 "Special") to
create your tournament games in your predefined tournament
area(s).
Rounds -
Used to regulate the number of rounds to be played in a
tournament. {available soon}
Team Play -
Used to define the area for a team tournament. This provides
for team-related statistics displays. {available soon}
- Page 4 -
Paths: Twit -
A text file can be created that contains a list of names you
wish to restrict from accessing this area.
Define the path and INCLUDE a file name. As mentioned
previously, your path is based upon your ChessMAGIC!
configuration:
twits.txt
twits\twits.txt
rated\twits\twits.txt
d:\doors\cmagic\twits\twits.txt
Paths: Bulletin -
An option, a game area specific bulletin file may be created and
displayed upon user entry to this area. This file could contain
special instructions, notices, etc.
Define the path and INCLUDE a file name. As mentioned
previously, your path is based on your configuration:
rated.bbs
bull\rated.bbs
rated\bull\rated.bbs
d:\doors\cmagic\bull\rated.bbs
Suspend Activity -
N = No
Y = Yes
Opens or closes this game area to user access. Handy during
area development or before announced tournament start dates, to
prevent premature user entry. {available soon}
<F1> = Help {available soon}
<F10> = Save current game area configuration and exit
<ESC> = Exit without saving changes
- Page 5 -
------------------------------------------------------------------------------
2.1.2 Edit Existing Area
------------------------------------------------------------------------------
Pressing "B" results in the display of a list of currently defined game
areas. Use your cursor keys to highlight the one you wish to edit,
then hit <ENTER>. Modify the game area fields as required, using the
procedures described in Section 3.1, above.
------------------------------------------------------------------------------
2.1.3 Game Maintenance
------------------------------------------------------------------------------
This action provides you with complete game editing controls within
each of your game areas. {board position setup/maintenance soon}
Pressing "C" results in the display of a list of currently defined game
areas. Use your cursor keys to highlight the one you wish to use, then
hit <ENTER>.
Next, type the number of the game you wish to edit and press <F10>. If
found, a game edit screen with the following fields will be displayed:
White Name -
White player name.
Rating (white) -
Rating of white player.
Black Name -
Black player name.
Rating (black) -
Rating of black player.
Current Status -
A = Active game
C = Completed game
D = Deleted game
J = Join game (awaiting an opponent)
- Page 6 -
Who's Move -
W = White
B = Black
Default Param: White Days/Moves/Date -
Days remaining before white defaults.
Number of moves made by white, this time frame.
Date of last move by white.
Default Param: Black Days/Moves/Date -
Days remaining before black defaults.
Number of moves made by black, this time frame.
Date of last move by black.
White Hours/Minutes/Seconds/Clock/Status
Timekeeping data.
Move Number -
Current move number for this game.
Game Status -
{reserved for future use}
Rating Flag -
{reserved for future use}
Message Flag -
0 = No action
>1 = Message waiting, notify
- Page 7 -
Piece Taken -
Last piece taken:
P = pawn
N = knight
B = bishop
R = rook
Q = queen
Capture List -
Holds ranked number of pieces (white/black) and types for
capture computations.
Default = 8822222211
Last Move -
Algebraic notation of last move made.
Rating Points Gained/Lost (White/Black) -
Determined at game conclusion and is automatically used by
ChessMAGIC! at times when game reinstatements are necessary.
<F1> = Help {available soon}
<F10> = Save current game data and exit
<ESC> = Exit without saving changes
- Page 8 -
------------------------------------------------------------------------------
2.1.4 BBS-Chess Conversion
------------------------------------------------------------------------------
For those of you who have an active BBS-Chess game collection underway,
this action enables you to convert everything (games & players) for
immediate ChessMAGIC! use. That's the _only_ reason for not making the
switch!
Pressing "D" brings up a menu that provides two conversion process
options:
1) Convert Players
Before running, copy the STATUS1 file to your ChessMAGIC! system
directory. You may delete the file upon completion of this
action.
Use this action to to pick up all existing BBS-Chess players
(names and ratings) from the STATUS1 file and have them added
into your master PLAYER.DBF file. If a player name already
exists in your master database, it will be skipped.
2) Convert Games
This option converts the pre-existing BBS-Chess games for
ChessMAGIC! use. Before running this option, copy the
BBSCHESS.xx and MOVES.xx files (xx = game number) to the game
area in which you wish the conversion to be performed.
You will have a choice of which ChessMAGIC! game area you wish
to perform these conversions (some of you may have been running
several BBS-Chess doors). Then, highlight the game area and
press <ENTER> to proceed with the conversion.
The process is rapid and you'll see the chess board and piece
updates, player names, etc. flash by, game by game. After all
games have been converted, a 5-second delay will occur while
system data is updated. After that, you'll be returned to the
main menu. The conversion process will erase the old
BBSCHESS.xx and MOVES.xx files, so KEEP BACKUPS! Any game
conversion error will be flagged (i.e. conversion will stop with
big notice), so make note of the game number -- in that case,
the corresponding MOVES.xx files will not be erased.
- Page 9 -
------------------------------------------------------------------------------
2.2 PLAYERS
------------------------------------------------------------------------------
This menu provides you with the means to perform maintenance on your
master players database. The following command actions are displayed:
A) Add New Player
B) Edit Existing Player
------------------------------------------------------------------------------
2.2.1 Add New Player
------------------------------------------------------------------------------
This is an option not normally needed, since ChessMAGIC! automatically
adds new players as they enter it for the first time.
Pressing "A" will result in a player definition screen, ready to have
these blank fields defined by you:
Name -
Make sure this matches the user name found in your BBS.
Rating -
The default is 1500, but you may wish to enter a previously
established rating for this player.
Class -
By default, all players begin as a class P (i.e. provisional).
Once they've completed at least 10 games, ChessMAGIC! will
assign them a standard classification.
The rating classes are as follows:
M = 2200+ (master)
X = 2000 - 2199 (expert)
A = 1800 - 1999
B = 1600 - 1799
C = 1400 - 1599
D = 1200 - 1399
E = 0 - 1199
P = Default (provisional - less than 10 games completed)
Wins/Losses/Draws -
Total game results stored here.
- Page 10 -
Accesses -
Total time ChessMAGIC! has been entered by player.
Date -
Date ChessMAGIC! was last entered by player.
Monitor -
General monitor selection type for the player:
0 = Mono
1 = Color
2 = Laptop
Board Settings: Foreground -
Foreground color settings for the white/black board squares.
Has nothing to do with piece colors. This is mainly to be used
in conjunction with the Background setting (below), as well as
the Block Style settings (below).
Board Settings: Background -
Background color settings for the white/black board squares.
Has nothing to do with piece colors. This is the main color
setting for squares. Can be used imaginatively in combination
with the Foreground and Block Style settings.
Board Settings: Intensity -
Determines low or high color intensity:
10 = normal
11 = high
Board Settings: Block Style -
Determines the tile pattern used for board squares. Color
combinations selected in Foreground/Background (above) have a
direct bearing on the effect of this setting.
1 = Space
2+ = Graphic Characters
Note: Selecting tile patterns 2-5 will result in slower board
drawing, but greater eye appeal.
- Page 11 -
Online Status -
Internally used/set by ChessMAGIC! to determine who is online.
Door ID -
Internally used/set by ChessMAGIC! (defined in Area
Configuration) to determine current/last area ID player
accessed.
Description -
Internally used/set by ChessMAGIC! (defined in Area
Configuration) as description of current/last area ID player
accessed.
<F1> = Help {available soon}
<F10> = Save current player data and exit
<ESC> = Exit without saving changes
------------------------------------------------------------------------------
2.2.2 Edit Existing Player
------------------------------------------------------------------------------
Pressing "B" displays a list of current players from the master
database. Use the cursor keys, highlight the player name to edit, then
hit <ENTER>. The same editing screen as outlined in Add New Player
(above) will appear, but fields will contain the chosen player's data.
Following the same instructions as previously covered, make the
necessary edits, then save with <F10> or abort with <ESC>.
------------------------------------------------------------------------------
2.3 SPECIAL
------------------------------------------------------------------------------
This menu provides you with the means to create tournaments and/or team
events, automatically! The following command actions are displayed:
A) Create Pairings
* B) Create Team
* C) Edit Team
* Note: Not yet enabled.
- Page 12 -
------------------------------------------------------------------------------
2.3.1 Create Pairings
------------------------------------------------------------------------------
This action is used to create tournament or other special pairings as
you might wish to hold in special areas from time to time, and is quite
flexible.
First, create a standard text file (PAIR.TXT) that contains one player
name per line (letter case and blank lines are ignored):
John Brown
George Bashful
Sarah Lockhart
etc...
You must be certain to spell user names correctly in order for
ChessMAGIC! to recognize them as either existing or new players as they
log in.
Place this file in the predefined game area where this tournament/team
action is to be held. An error will be displayed if this file is not
found, so BE SURE the area has been defined!
Pressing "A" will then display a list of defined game areas. Using
your cursor keys, highlight the required are and press <ENTER>. The
pairings will be generated automatically, each player against the
others found in PAIR.TXT as both White _and_ Black.
For tournaments with more than 1 round, simply use the same PAIR.TXT
and follow the same procedures outlined above to create additional
games.
NOTE: The actual *.MVE files are created as players access their
games. Only the area game master database is initialized to
begin with.
------------------------------------------------------------------------------
2.4 UTILITY
------------------------------------------------------------------------------
This menu provides you with the means for customization of the utility
menu colors, BBS name displayed in ChessMAGIC! and an automatic
maintenance option.
The following command actions are displayed:
A) Screen Colors
B) BBS Name Entry
C) Auto Maintenance
- Page 13 -
Pressing "A" displays five possible menu color combinations from which
to choose. Making a choice of 1-5 returns you to the main menu, colors
changed and stored accordingly.
Pressing "B" will cause a prompt at which you may enter your BBS name
or whatever other line you would like displayed in the ChessMAGIC! main
menu (all areas). To save your entry, press <F10> -- abort by tapping
<ESC>.
Pressing "C" will prompt you to confirm the automated ChessMAGIC!
system maintenance request. "N" returns you to the main menu and "Y"
will begin the action. During the maintenance process, all game area
databases/indexes and your player master file checked, updated and
corrected as necessary. This process is fairly rapid and its progress
will be displayed. Once completed, you will be returned to the main
menu.
------------------------------------------------------------------------------
2.5 QUIT
------------------------------------------------------------------------------
Used to exit the ChessMAGIC! Utility -- hit "E" after selecting.
- Page 13 -
------------------------------------------------------------------------------
3.0 DISCLAIMER/AGREEMENT
------------------------------------------------------------------------------
Users of ChessMAGIC! and its utilities must accept this disclaimer of
warranty:
"ChessMAGIC! is supplied as is. The author disclaims all warranties,
expressed or implied, including, without limitation, the warranties of
merchantability and of fitness for any purpose. The author assumes no
liability for damages, direct or consequential, which may result from
the use of ChessMAGIC! and it's related utilities."
This product is a commercial product and may not be distributed in
any fashion or form without the written consent from KnightWare.
------------------------------------------------------------------------------
4.0 PRODUCT SUPPORT
------------------------------------------------------------------------------
Registered ChessMAGIC! sysops receive UNLIMITED FREE TECHNICAL SUPPORT
through our distribution system, Decibel BBS.
For a period of 90 days following your receipt of the initial
registered ChessMAGIC! package (by mail or download), ALL maintenance
and/or major update releases will be downloadable FREE from Decibel
BBS, our support system.
Any problems reported by you during this period will be expedited in a
courteous and professional manner. If the resolution of your reported
problem is not made until after the normal 90 day period has expired,
the corrected version will be provided when ready.
NOTE: Usually, most software bugs are discovered within the first 30
days of regular use. Commercial software publishers might
provide you with a bug fix or two, but only if you're lucky and
complain loudly enough. But do they provide even one general
update? Not hardly! With ChessMAGIC! registration, this 90 day
FREE update service makes it an excellent value.
You are encouraged to submit ANY suggestions you and/or your users may
have about ChessMAGIC! that will enable us to enhance this product!
Our goal is to keep ChessMAGIC! the #1 BBS chess door available and YOU
can help!
- Page 14 -